Call Appearance Incoming or Outgoing Message Parameter Block (IM: Telephony)

Chapter 6 - Telephone Tools / Telephone Tools Reference

Call Appearance Incoming or Outgoing Message Parameter Block
Your telephone tool passes a pointer to a call appearance incoming or outgoing message parameter block when sending a message about a call appearance that is currently coming in or going out. The call appearance incoming or outgoing message parameter block is defined by the TELCAInOutMsgPB data type.
struct TELCAInOutMsgPB {
   short                   toolID;
   short                   tRef;
   short                   dnRef;
   short                   caRef;
   long                    msg;
   short                   mtype;
   short                   value;
   StringPtr               rmtDN;
   StringPtr               rmtName;
   StringPtr               rmtSubaddress;
   short                   caState;
   short                   intExt;
   short                   callType;
   short                   dialType;
   short                   bearerType;
   short                   rate;
   StringPtr               routeDN;
   StringPtr               routeName;
   StringPtr               routeSubaddress;
   long                    featureFlags;
   long                    otherFeatures;
   long                    telCAPrivate;
};
typedef struct TELCAInOutMsgPB TELCAInOutMsgPB;
Field Description

toolID
The tool ID of your telephone tool.
tRef
The reference number of a telephone terminal. Your telephone tool assigns this number when the terminal is opened. You should not change this number as long as the terminal is open.
dnRef
The reference number of a directory number. You should not change this number as long as the directory number is valid.
caRef
The reference number of a call appearance. You should not change this number as long as the call appearance is valid.
msg
The message your tool is sending to the Telephone Manager.
mtype
A message type. The value in this field varies according to the message specified in the msg field. See the description of each particular message for information about this field.
value
A message value. The value in this field varies according to the message specified in the msg field. See the description of each particular message for information about this field.
rmtDN
A pointer to a Pascal-style string that stores the remote directory number to which the call is to be transferred.
rmtName
A pointer to a Pascal-style string that stores the name associated with a remote directory number.
rmtSubaddress
A pointer to a Pascal-style string that stores the subaddress of the specified remote directory number.
caState
A constant that indicates the state of the call. See "Call Appearance States" (page 4-10) for a description of call appearance states.
intExt
Information about where the call originates relative to the local switch or closed user group. See "Call Origination Types" (page 4-13) for a description of the constants you can pass in this field.
callType
Indicates the way in which the call reached or left this terminal--for instance, whether it was transferred or forwarded. The constants that define call types are described in "Call Types" (page 4-11).
dialType
A value that specifies the type of directory number and name contained in the rmtDN and rmtName fields. See "Dial Types" on page 4-14 for a description of the available dial types.
bearerType
Reserved. A telephone tool always sets this to 0.
rate
Reserved. A telephone tool always sets this to 0.
routeDN
A pointer to a Pascal-style string containing the telephone number through which this incoming call was routed. If the call was not routed or if the routing telephone number is unknown, this field contains nil.
routeName
A pointer to a Pascal-style string containing the name of the party associated with the routing telephone number. If the name of the party is unknown, this field contains nil.
routeSubaddress
A pointer to the network subaddress of the routing telephone number. If there is no subaddress, this field contains nil.
featureFlags
A bit field that indicates certain features of this call appearance and the state of each feature (subscribed, available, or active). The constants that define the bits are described in "Call Appearance Feature Flags" (page 4-14).
otherFeatures
A bit field that indicates additional features of this call appearance and the state of each feature (subscribed, available, or active). The constants that define the bits are described in "Other Call Appearance Feature Flags" (page 4-16).
telCAPrivate
A pointer to the private data that your tool wants stored in the call appearance structure associated with the call appearance specified by the caRef field.